home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cggesx.z / cggesx
Encoding:
Text File  |  2002-10-03  |  10.3 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))                                                          CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGGESX - compute for a pair of N-by-N complex nonsymmetric matrices
  10.      (A,B), the generalized eigenvalues, the complex Schur form (S,T),
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CGGESX( JOBVSL, JOBVSR, SORT, SELCTG, SENSE, N, A, LDA, B,
  14.                         LDB, SDIM, ALPHA, BETA, VSL, LDVSL, VSR, LDVSR,
  15.                         RCONDE, RCONDV, WORK, LWORK, RWORK, IWORK, LIWORK,
  16.                         BWORK, INFO )
  17.  
  18.          CHARACTER      JOBVSL, JOBVSR, SENSE, SORT
  19.  
  20.          INTEGER        INFO, LDA, LDB, LDVSL, LDVSR, LIWORK, LWORK, N, SDIM
  21.  
  22.          LOGICAL        BWORK( * )
  23.  
  24.          INTEGER        IWORK( * )
  25.  
  26.          REAL           RCONDE( 2 ), RCONDV( 2 ), RWORK( * )
  27.  
  28.          COMPLEX        A( LDA, * ), ALPHA( * ), B( LDB, * ), BETA( * ), VSL(
  29.                         LDVSL, * ), VSR( LDVSR, * ), WORK( * )
  30.  
  31.          LOGICAL        SELCTG
  32.  
  33.          EXTERNAL       SELCTG
  34.  
  35. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  36.      These routines are part of the SCSL Scientific Library and can be loaded
  37.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  38.      directs the linker to use the multi-processor version of the library.
  39.  
  40.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  41.      4 bytes (32 bits). Another version of SCSL is available in which integers
  42.      are 8 bytes (64 bits).  This version allows the user access to larger
  43.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  44.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  45.      only one of the two versions; 4-byte integer and 8-byte integer library
  46.      calls cannot be mixed.
  47.  
  48. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  49.      CGGESX computes for a pair of N-by-N complex nonsymmetric matrices (A,B),
  50.      the generalized eigenvalues, the complex Schur form (S,T), and,
  51.      optionally, the left and/or right matrices of Schur vectors (VSL and
  52.      VSR).  This gives the generalized Schur factorization
  53.  
  54.           (A,B) = ( (VSL) S (VSR)**H, (VSL) T (VSR)**H )
  55.  
  56.      where (VSR)**H is the conjugate-transpose of VSR.
  57.  
  58.      Optionally, it also orders the eigenvalues so that a selected cluster of
  59.      eigenvalues appears in the leading diagonal blocks of the upper
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))                                                          CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      triangular matrix S and the upper triangular matrix T; computes a
  75.      reciprocal condition number for the average of the selected eigenvalues
  76.      (RCONDE); and computes a reciprocal condition number for the right and
  77.      left deflating subspaces corresponding to the selected eigenvalues
  78.      (RCONDV). The leading columns of VSL and VSR then form an orthonormal
  79.      basis for the corresponding left and right eigenspaces (deflating
  80.      subspaces).
  81.  
  82.      A generalized eigenvalue for a pair of matrices (A,B) is a scalar w or a
  83.      ratio alpha/beta = w, such that  A - w*B is singular.  It is usually
  84.      represented as the pair (alpha,beta), as there is a reasonable
  85.      interpretation for beta=0 or for both being zero.
  86.  
  87.      A pair of matrices (S,T) is in generalized complex Schur form if T is
  88.      upper triangular with non-negative diagonal and S is upper triangular.
  89.  
  90.  
  91. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  92.      JOBVSL  (input) CHARACTER*1
  93.              = 'N':  do not compute the left Schur vectors;
  94.              = 'V':  compute the left Schur vectors.
  95.  
  96.      JOBVSR  (input) CHARACTER*1
  97.              = 'N':  do not compute the right Schur vectors;
  98.              = 'V':  compute the right Schur vectors.
  99.  
  100.      SORT    (input) CHARACTER*1
  101.              Specifies whether or not to order the eigenvalues on the diagonal
  102.              of the generalized Schur form.  = 'N':  Eigenvalues are not
  103.              ordered;
  104.              = 'S':  Eigenvalues are ordered (see SELCTG).
  105.  
  106.      SELCTG  (input) LOGICAL FUNCTION of two COMPLEX arguments
  107.              SELCTG must be declared EXTERNAL in the calling subroutine.  If
  108.              SORT = 'N', SELCTG is not referenced.  If SORT = 'S', SELCTG is
  109.              used to select eigenvalues to sort to the top left of the Schur
  110.              form.  Note that a selected complex eigenvalue may no longer
  111.              satisfy SELCTG(ALPHA(j),BETA(j)) = .TRUE. after ordering, since
  112.              ordering may change the value of complex eigenvalues (especially
  113.              if the eigenvalue is ill-conditioned), in this case INFO is set
  114.              to N+3 see INFO below).
  115.  
  116.      SENSE   (input) CHARACTER
  117.              Determines which reciprocal condition numbers are computed.  =
  118.              'N' : None are computed;
  119.              = 'E' : Computed for average of selected eigenvalues only;
  120.              = 'V' : Computed for selected deflating subspaces only;
  121.              = 'B' : Computed for both.  If SENSE = 'E', 'V', or 'B', SORT
  122.              must equal 'S'.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))                                                          CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      N       (input) INTEGER
  141.              The order of the matrices A, B, VSL, and VSR.  N >= 0.
  142.  
  143.      A       (input/output) COMPLEX array, dimension (LDA, N)
  144.              On entry, the first of the pair of matrices.  On exit, A has been
  145.              overwritten by its generalized Schur form S.
  146.  
  147.      LDA     (input) INTEGER
  148.              The leading dimension of A.  LDA >= max(1,N).
  149.  
  150.      B       (input/output) COMPLEX array, dimension (LDB, N)
  151.              On entry, the second of the pair of matrices.  On exit, B has
  152.              been overwritten by its generalized Schur form T.
  153.  
  154.      LDB     (input) INTEGER
  155.              The leading dimension of B.  LDB >= max(1,N).
  156.  
  157.      SDIM    (output) INTEGER
  158.              If SORT = 'N', SDIM = 0.  If SORT = 'S', SDIM = number of
  159.              eigenvalues (after sorting) for which SELCTG is true.
  160.  
  161.      ALPHA   (output) COMPLEX array, dimension (N)
  162.              BETA    (output) COMPLEX array, dimension (N) On exit,
  163.              ALPHA(j)/BETA(j), j=1,...,N, will be the generalized eigenvalues.
  164.              ALPHA(j) and BETA(j),j=1,...,N  are the diagonals of the complex
  165.              Schur form (S,T).  BETA(j) will be non-negative real.
  166.  
  167.              Note: the quotients ALPHA(j)/BETA(j) may easily over- or
  168.              underflow, and BETA(j) may even be zero.  Thus, the user should
  169.              avoid naively computing the ratio alpha/beta.  However, ALPHA
  170.              will be always less than and usually comparable with norm(A) in
  171.              magnitude, and BETA always less than and usually comparable with
  172.              norm(B).
  173.  
  174.      VSL     (output) COMPLEX array, dimension (LDVSL,N)
  175.              If JOBVSL = 'V', VSL will contain the left Schur vectors.  Not
  176.              referenced if JOBVSL = 'N'.
  177.  
  178.      LDVSL   (input) INTEGER
  179.              The leading dimension of the matrix VSL. LDVSL >=1, and if JOBVSL
  180.              = 'V', LDVSL >= N.
  181.  
  182.      VSR     (output) COMPLEX array, dimension (LDVSR,N)
  183.              If JOBVSR = 'V', VSR will contain the right Schur vectors.  Not
  184.              referenced if JOBVSR = 'N'.
  185.  
  186.      LDVSR   (input) INTEGER
  187.              The leading dimension of the matrix VSR. LDVSR >= 1, and if
  188.              JOBVSR = 'V', LDVSR >= N.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))                                                          CCCCGGGGGGGGEEEESSSSXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      RCONDE  (output) REAL array, dimension ( 2 )
  207.              If SENSE = 'E' or 'B', RCONDE(1) and RCONDE(2) contain the
  208.              reciprocal condition numbers for the average of the selected
  209.              eigenvalues.  Not referenced if SENSE = 'N' or 'V'.
  210.  
  211.      RCONDV  (output) REAL array, dimension ( 2 )
  212.              If SENSE = 'V' or 'B', RCONDV(1) and RCONDV(2) contain the
  213.              reciprocal condition number for the selected deflating subspaces.
  214.              Not referenced if SENSE = 'N' or 'E'.
  215.  
  216.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  217.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  218.  
  219.      LWORK   (input) INTEGER
  220.              The dimension of the array WORK.  LWORK >= 2*N.  If SENSE = 'E',
  221.              'V', or 'B', LWORK >= MAX(2*N, 2*SDIM*(N-SDIM)).
  222.  
  223.      RWORK   (workspace) REAL array, dimension ( 8*N )
  224.              Real workspace.
  225.  
  226.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  227.              Not referenced if SENSE = 'N'.  On exit, if INFO = 0, IWORK(1)
  228.              returns the optimal LIWORK.
  229.  
  230.      LIWORK  (input) INTEGER
  231.              The dimension of the array WORK. LIWORK >= N+2.
  232.  
  233.      BWORK   (workspace) LOGICAL array, dimension (N)
  234.              Not referenced if SORT = 'N'.
  235.  
  236.      INFO    (output) INTEGER
  237.              = 0:  successful exit
  238.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  239.              = 1,...,N:  The QZ iteration failed.  (A,B) are not in Schur
  240.              form, but ALPHA(j) and BETA(j) should be correct for
  241.              j=INFO+1,...,N.  > N:  =N+1: other than QZ iteration failed in
  242.              CHGEQZ
  243.              =N+2: after reordering, roundoff changed values of some complex
  244.              eigenvalues so that leading eigenvalues in the Generalized Schur
  245.              form no longer satisfy SELCTG=.TRUE.  This could also be caused
  246.              due to scaling.  =N+3: reordering failed in CTGSEN.
  247.  
  248. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  249.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  250.  
  251.      This man page is available only online.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.